Skip to content

Docs: Convert document Overviews and Best Practices to markdown #4512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Jahnp merged 24 commits into from
Apr 17, 2018
Merged

Docs: Convert document Overviews and Best Practices to markdown #4512

Jahnp merged 24 commits into from
Apr 17, 2018

Conversation

@jordandrako
Copy link
Contributor

@jordandrako jordandrako commented Apr 11, 2018 •
edited
Loading

Pull request checklist

Description of changes

For all components (excluding those in Experiments package)

  • Add componentUrls to component example pages
  • Move Overview to ./docs/Overview.md file
  • Move BestPractices to ./docs/BestPractices.md file
  • Move Dos to ./docs/Dos.md file
  • Move Donts to ./docs/Donts.md file

Also changed/updated/fixed:

Let me know if the bugfix and opt-in, or any other added changes should be in separate PRs.

Focus areas to test

Test if edit button link will go to the right place.

@jordandrako jordandrako changed the title [DON'T MERGE YET] Docs: Convert document Overviews, Dos, and Don'ts to markdown Docs: Convert document Overviews, Dos, and Don'ts to markdown Apr 11, 2018
mikewheaton
mikewheaton reviewed Apr 12, 2018
View reviewed changes
.github/CODEOWNERS
Toggle/ @phkuo
Tooltip/ @micahgodbolt

## Docs
Copy link
Contributor

@mikewheaton mikewheaton Apr 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to use the same code owners as the rest of the component for now, but over time we'll want to find design owners who can review the usage guidelines.

manishgarg1
manishgarg1 approved these changes Apr 12, 2018
View reviewed changes
Copy link
Collaborator

@manishgarg1 manishgarg1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@manishgarg1
Copy link
Collaborator

manishgarg1 commented Apr 12, 2018

Approved with the note that this is just a move. It is hard to read through all comments. Are there any changes that are not just a physical move?

@jordandrako jordandrako changed the title Docs: Convert document Overviews, Dos, and Don'ts to markdown Docs: Convert document Overviews and Best Practices to markdown Apr 12, 2018
@jordandrako
Copy link
Contributor Author

jordandrako commented Apr 12, 2018

@manishgarg1 The only changes other than converting to markdown:

  • Add componentUrl to each page to enable the edit buttons.
  • Fixing any grammar or spelling mistakes I found in my quick scanning.
  • Add link to our Icon document to Icon overview and IconButton example.

@jordandrako
Copy link
Contributor Author

jordandrako commented Apr 13, 2018

Overhauled the "Themes" page so I could use markdown. It now pulls the theme palettes dynamically instead of being hardcoded. Added semanticColors as well.

@jordandrako
Copy link
Contributor Author

jordandrako commented Apr 13, 2018

Themes page before:
image

Themes page after:
image
image
image

@phkuo
Copy link
Contributor

phkuo commented Apr 13, 2018

@jordandrako does it leave out the deprecated semantic slots?

@jordandrako
Copy link
Contributor Author

jordandrako commented Apr 14, 2018

@phkuo Finished adding @deprecated opt-in functionality and now the documentation shows deprecated color slots as deprecated.

@jordandrako
Copy link
Contributor Author

jordandrako commented Apr 16, 2018

@Jahnp @dzearing Do you have any issues with the changes here and can we get this wrapped up? See my PR comment for the full list of changes.

@Jahnp
Copy link
Member

Jahnp commented Apr 17, 2018

Sorry for the delay @jordandrako. This is an awesome set of changes. Looking now.

@Jahnp Jahnp merged commit 4efff92 into microsoft:master Apr 17, 2018
jordandrako pushed a commit to jordandrako/office-ui-fabric-react that referenced this pull request Apr 19, 2018
Remove unintended changes in dropdown from microsoft#4512
1a39ed3
jordandrako added a commit that referenced this pull request Apr 20, 2018
@jordandrako
Revert unintended changes in Dropdown from #4512 (#4625)
ef0cfe4 
* Remove unintended changes in dropdown from #4512
@microsoft microsoft locked as resolved and limited conversation to collaborators Aug 31, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Jahnp Jahnp Jahnp approved these changes

@joschect joschect Awaiting requested review from joschect

@lorejoh12 lorejoh12 Awaiting requested review from lorejoh12

@micahgodbolt micahgodbolt Awaiting requested review from micahgodbolt

@srideshpande srideshpande Awaiting requested review from srideshpande

@aditima aditima Awaiting requested review from aditima

@cschleiden cschleiden Awaiting requested review from cschleiden

@phkuo phkuo Awaiting requested review from phkuo

@ThomasMichon ThomasMichon Awaiting requested review from ThomasMichon

@yiminwu yiminwu Awaiting requested review from yiminwu

+3 more reviewers

@atneik atneik atneik approved these changes

@mikewheaton mikewheaton mikewheaton approved these changes

@manishgarg1 manishgarg1 manishgarg1 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jordandrako @manishgarg1 @phkuo @Jahnp @atneik @mikewheaton